@material/animation

What is @material/animation?

@material/animation is a utility package from Material Design Components (MDC) that provides a set of functions and constants to help create smooth and consistent animations. It is designed to be used with other MDC components to ensure that animations follow Material Design guidelines.

What are @material/animation's main functionalities?

Animation Curves

Provides predefined animation curves such as easeInOut, easeOut, and easeIn that can be used to create smooth transitions and animations.

const { easeInOut, easeOut, easeIn } = require('@material/animation');

// Example usage in a CSS-in-JS style object
const styles = {
  transition: `all 250ms ${easeInOut}`
};

Animation Durations

Includes standard durations for animations, such as short, medium, and long, to ensure consistency across different components.

const { duration } = require('@material/animation');

// Example usage in a CSS-in-JS style object
const styles = {
  transitionDuration: `${duration.standard}ms`
};

Keyframe Animations

Provides utility functions to handle keyframe animations and ensure compatibility across different browsers.

const { getCorrectEventName } = require('@material/animation');

// Example usage in JavaScript
const animationEndEvent = getCorrectEventName(window, 'animationend');
element.addEventListener(animationEndEvent, () => {
  console.log('Animation ended');
});

Other packages similar to @material/animation

animejs

Anime.js is a lightweight JavaScript animation library with a simple, yet powerful API. It supports various types of animations including CSS properties, SVG, DOM attributes, and JavaScript objects. Compared to @material/animation, Anime.js offers a more extensive set of features and greater flexibility for complex animations.

gsap

GSAP (GreenSock Animation Platform) is a robust JavaScript library for high-performance animations. It is widely used for creating complex timelines and animations with precise control. GSAP provides more advanced features and customization options compared to @material/animation, making it suitable for more intricate animation needs.

velocity-animate

Velocity is an animation engine that combines the best of jQuery and CSS transitions. It offers a rich set of features for creating smooth animations and is known for its performance. While @material/animation focuses on Material Design guidelines, Velocity provides a more general-purpose solution for web animations.

README

Animation

Material in motion is responsive and natural. Use these easing curves and duration patterns to create smooth and consistent motion.

Design & API Documentation

• Material Design guidelines: Motion

Installation

npm install @material/animation

Usage

Sass Variables

We provide timing functions which you can use with the animation or transition CSS properties

@use "@material/animation";

.my-element--animating {
  animation: foo-keyframe 175ms animation.$standard-curve-timing-function;
}

Variable	Description
$deceleration-curve-timing-function	Timing function to decelerate
$standard-curve-timing-function	Timing function to quickly accelerate and slowly decelerate
$acceleration-curve-timing-function	Timing function to accelerate
$sharp-curve-timing-function	Timing function to quickly accelerate and decelerate

The following functions create transitions given $name and the $duration. You can also specify $delay, but the default is 0ms. $name can either refer to the keyframe, or to CSS property used in transition.

@use "@material/animation";

.my-element {
  transition: animation.exit-permanent(/* $name: */ opacity, /* $duration: */ 175ms, /* $delay: */ 150ms);
  opacity: 0;
  will-change: opacity;

  &--animating {
    transition: animation.enter(/* $name: */ opacity, /* $duration: */ 175ms);
    opacity: 1;
  }
}

@use "@material/animation";

@keyframes fade-in {
  from {
    transform: translateY(-80px);
    opacity: 0;
  }

  to {
    transform: translateY(0);
    opacity: 1;
  }
}

.my-element {
  animation: animation.enter(/* $name: */ fade-in, /* $duration: */ 350ms);
}

Function	Description
enter($name, $duration, $delay)	Defines transition for entering the frame
exit-permanent($name, $duration, $delay)	Defines transition for exiting the frame permanently
exit-temporary($name, $duration, $delay)	Defines transition for exiting the frame temporarily

JavaScript

These functions handle prefixing across various browsers

import {getCorrectEventName} from '@material/animation';

const eventToListenFor = getCorrectEventName(window, 'animationstart');

Method Signature	Description
getCorrectEventName(windowObj: Window, eventType: StandardJsEventType) => StandardJsEventType | PrefixedJsEventType	Returns a JavaScript event name, prefixed if necessary. See types.ts for supported values.
getCorrectPropertyName(windowObj: Window, cssProperty: StandardCssPropertyName) => StandardCssPropertyName | PrefixedCssPropertyName	Returns a CSS property name, prefixed if necessary. See types.ts for supported values.

Changelog

13.0.0 (2021-09-24)

Bug Fixes

• Fix missing $ripple-target param for ripple mixin (1340ee9)
• banner: Adjusting theme api selectors to use mdc-button. (15981e9)
• banner: Correcting incorrect theme values passed through to button's theme-mixin. (0de2f2e)
• banner: exclude source from npm package (#7381) (d48a017), closes #7360
• banner: Removing action-<state>-label-text-color values from MDC light-theme map. (d97f8f1)
• button: cleanup outlined button theme keys (28d0d75)
• button: fix touch target reset in context of link buttons (3b8d442)
• button: remove negative padding around icons (d470693)
• button: remove rem/em transformers from typography theme-styles (a395972)
• button: stack ripple behind content (e1e69fd)
• density: typo in variable exports (6df682e)
• dom: Support providing an owner document for announcer messages. (6236f35)
• elevation: reduce warnings when not providing elevation tokens (adb9f1a)
• iconbutton: Fix icon button theme keys/light theme values based on updated tokens. (42d175e)
• menu: apply elevation overlay to new lists (0ad12ed)
• sass: Wrap templated calc expressions in strings (818f4ee), closes #7391
• slider: Reorder such that dragstart event is emitted before any other events when handling drag start. (877e3fb)
• slider: Replace innerHTML with firstChild (37d4db8)
• Fix compilation issues with TypeScript 4.4 (7246447)
• switch: add pointer cursor (12f5622)
• switch: distribute correct css (#7292) (7b6bcb8)
• switch: elevation theme custom properties not working (2865629)
• switch: use correct colors for icons in all HCM themes (d86fb6f)
• theme: ensure state selectors negate properly (7249a30)
• tooltip: Add a getActiveElement() method to MDCTooltipAdapter to delegate getting the active element from the correct document. (e334676)
• tooltip: Adjust tooltip focusout handler. Ensures that interactive tooltips remain open when ChromeVox uses linear navigation to read non-focusable content inside the tooltip. (7c96e6b)
• tooltip: non-persistent tooltips disappear on scroll (1f9259b)
• update combined mdc package to use new switch CSS (077dcfc), closes #7304
• tooltip: allow the Mac zoom service to access plain tooltip contents (510cf90)

Code Refactoring

• fab: Deprecate legacy Fab theme mixins (83bdd02)
• iconbutton: Forward only theme mixins from MDC icon button index module. (0a90693)
• theme: Rename validate-keys() to validate-theme() (2fb068f)

Features

• button: add custom props to outlined button theme-styles (bf405d2)
• button: add custom props to protected button theme-styles (4ca11fe)
• button: add custom props to text button theme-styles (3dd6110)
• button: add missing transitions to box-shadow/border (3b92903)
• button: add static-styles-without-ripple for MWC consumption (f4241a4)
• button: add theme mixin that emits custom properties instead (4c40586)
• button: emit custom properties fill button theme-styles (a80c8b2)
• button: m3 elevation + icon base theme modules (2da3606)
• button: resolve elevation keys in theme mixin (843342f)
• chips: Add theming Sass mixin to MDC Filter Chip (8390093)
• chips: Add theming Sass mixin to MDC input & suggestion Chip (860ad06)
• chips: Added theme mixins to Assist Chip (d4e16a6)
• chips: Export all non-deprecated members through chips index (8647986)
• chips: Rename action's exported members to avoid naming collisions (b49359c)
• chips: Rename chip set's exported members to avoid naming collisions (13db34b)
• chips: Rename chip's exported members to avoid naming collisions (470bd34)
• data-table: Implement row click feature to MDC data table (8de07c0)
• data-table: use new select + list templates for pagination (08398f8)
• dialog: Add theme styles mixin to dialog (21ece53)
• dialog: Separate static styles from dialog core-styles mixin (43d2eed)
• fab: create theming file for small fabs (d082790)
• fab: prepare fab-extended for theming in MWC (ce25bc3)
• iconbutton: Add .mdc-icon-button--display-flex class that centers icon via flexbox. When using the new theme API, the icon button should have this class. (8355e14)
• iconbutton: Add MDC theme mixin that declares custom properties. (fa7520f)
• iconbutton: Add theme styles mixin. (65aa63b)
• menu: Added getter method to check fixed position status of menu (fb76c50)
• menu: Adds option to prevent focus from being restored after an item action. (65084ba)
• select: start compatibility work for evolution lists (e8554db)
• theme: Added validate-theme-keys() mixin to validate theme keys only (457d89a)

BREAKING CHANGES

• menu: Adds new menu adapter method:

  /**

  • @return the attribute string if present on an element at the index
  • provided, null otherwise. */ getAttributeFromElementAtIndex(index: number, attr: string): string|null;

PiperOrigin-RevId: 398575780

• iconbutton: MDC iconbutton _index Sass module will only export theme mixins.

PiperOrigin-RevId: 391773229

• theme: Renamed Sass mixins validate-keys() to validate-theme() in @material/theme

PiperOrigin-RevId: 390671152

• fab: Renamed Fab's mixins to deprecate legacy theme mixins.

PiperOrigin-RevId: 387378201